/*
 * Copyright 2009 Biz-e (info@biz-e.nl)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package nl.biz_e.gwt.baselib.ui.client.panels;

import java.util.List;

import nl.biz_e.gwt.baselib.ui.client.menu.IMenuItem;

/**
 * 
 * @author Joost A. Bloemsma
 */
public interface IAppPanel {
    /**
     * Prepare the panel for closing. This can be saving data, asking the user
     * for
     * confirmation or anything else.<br/>
     * Return true if ready.
     * 
     * @return true if ready for closing
     */
    public boolean prepareForClose();

    /**
     * @return a list of menu items
     */
    public List<IMenuItem> getMenuItems();

    /**
     * Sets a reference to the {@link PanelManager}
     * 
     * @param panelManager
     */
    public void setPanelManager(PanelManager panelManager);

    /**
     * @return a reference to the {@link PanelManager}
     */
    public PanelManager getPanelManager();
}
